Node / meshtastic / Meshtastic-Android / files / AGENTS.md

Displaying Rendered • View raw • Download

<role>

You are an expert Android/KMP engineer. Maintain architectural boundaries, use MAD standards, and adhere to Compose Multiplatform + Navigation 3.

</role>

<contextandmemory>

• Project Goal: Decouple business logic from Android for multi-platform (Android, Desktop, iOS).

• Tech: Kotlin 2.3+ (JDK 21), Ktor, Okio, Room KMP, Koin 4.2+.

• Agent Memory: Skim the top (most recent) entry of T383838.agent_memory/session_context.md for current state — it is capped at ~5 entries; older handovers live in T383838session_context.archive.md (read only if you need historical detail).

• Skills Directory (CONSULT THESE FIRST):

• T383838.skills/project-overview/ - Codebase map, namespacing, Bootstrap Steps.

• T383838.skills/kmp-architecture/ - Expect/actual, source-sets, conventions.

• T383838.skills/compose-ui/ - Adaptive UI, String Resources (consult strings-index.txt first).

• T383838.skills/navigation-and-di/ - Navigation 3 & Koin annotations.

• T383838.skills/testing-ci/ - Validation commands, CI Architecture.

• T383838.skills/ci-cost-control/ - CI Budgeting & Monitoring.

• T383838.skills/implement-feature/ - Feature workflow.

• T383838.skills/code-review/ - PR & Commit Hygiene, validation checklist.

• T383838.skills/new-branch/ - Branching and rebasing recipes.

• T383838.skills/speckit/ - Spec Kit SDD workflow, slash commands, constitution, feature specs.

</contextandmemory>

<process_essentials>

• Think First: Read only what you need. Consult indices (like T383838strings-index.txt) before reading large files.

• Hygiene: Run T383838python3 scripts/sort-strings.py after adding new string resources to maintain organization and update the index.

• Memory Persistence: Add a new entry to the TOP of T383838.agent_memory/session_context.md at the end of every session or major task. Keep it capped at ~5 entries — move anything older to T383838session_context.archive.md.

• Bootstrap First: Run the mandatory bootstrap steps in T383838.skills/project-overview/SKILL.md before any build.

• Plan Before Execution: Use T383838.agent_plans/ (git-ignored) for complex refactors.

• Baseline Verification: Always run: T383838./gradlew spotlessApply spotlessCheck detekt assembleDebug test allTests

</process_essentials>

<rules>

• Token Hygiene: NEVER read binary files (PNG, MP3, etc.) or large non-code resources unless essential. Use file paths to reason about assets.

• Context Discipline: Limit your context to relevant modules. Do not "vacuum" the entire codebase for localized fixes.

• No Lazy Coding: DO NOT use placeholders like T383838// ... existing code .... Provide complete, valid code blocks.

• No Framework Bleed: NEVER import T383838java.* or T383838android.* in T383838commonMain. Use KMP equivalents (Okio, Mutex, atomicfu).

• CMP Over Android: Use T383838compose-multiplatform constraints. Pre-format floats with T383838NumberFormatter.format(). Use T383838MeshtasticNavDisplay and T383838NavigationBackHandler.

• Zero Lint Tolerance: Task is incomplete if T383838detekt or T383838spotlessCheck fails.

• Verify Before Push: Treat any "push" as verify-then-push. CI has failed repeatedly due to skipped local checks.

• Never Touch Protos or Secrets: T383838core/proto is an upstream submodule. Secrets are git-ignored.

• Privacy First: Never log or expose PII, location, or cryptographic keys.

</rules>

<documentation_sync>

T383838AGENTS.md is the source of truth for rules and principles. T383838.github/copilot-instructions.md provides a quick-reference subset optimized for Copilot sessions (build commands, task naming, conventions). T383838CLAUDE.md and T383838GEMINI.md redirect here.

</documentation_sync>

<!-- SPECKIT START -->

For additional context about technologies to be used, project structure,

shell commands, and other important information, read the current plan

<!-- SPECKIT END -->